Add a hook for intercepting decoding errors #99
Conversation
This is just a proof-of-concept, if this direction is reasonable, it should be fleshed out to handle all decoding paths. See apple/swift-openapi-generator#522 for motivation.
| @@ -96,6 +96,10 @@ extension JSONDecoder.DateDecodingStrategy { | |||
| } | |||
| } | |||
|
|
|||
| public protocol DecodingErrorHandler: Sendable { | |||
| func willThrow(_ error: any Error) | |||
There was a problem hiding this comment.
Would you be interested in the context this was thrown in? See ClientError and ServerError, where we add more context.
| @@ -113,9 +119,11 @@ public struct Configuration: Sendable { | |||
| /// - multipartBoundaryGenerator: The generator to use when creating mutlipart bodies. | |||
| public init( | |||
| dateTranscoder: any DateTranscoder = .iso8601, | |||
| multipartBoundaryGenerator: any MultipartBoundaryGenerator = .random | |||
| multipartBoundaryGenerator: any MultipartBoundaryGenerator = .random, | |||
| decodingErrorHandler: (any DecodingErrorHandler)? = nil | |||
There was a problem hiding this comment.
Looks good, please just add a deprecated 2-parameter version of this initializer in Deprecated.swift, as adding a param is technically a source break. Similar to #102 (comment)
|
Hi @jpsim - are you still interested in a solution here? I'm happy with either you picking this up again, or letting us take over. It'd just be good to finalize the details with a concrete use case in mind. |
|
I won't be pursuing this further. |
May I ask if it's because you found a workflow where you don't need it, or if you don't have the bandwidth to drive the PR? |
|
We're using this library pretty heavily and this would be a fantastic addition that would help us catch a lot of stuff in Datadog instead of finding out API responses aren't decoding properly from customer complaints. |
|
We're open to this enhancement, and with JP closing this PR, I think it'd be appropriate for someone else to open a new PR and we can discuss next steps there. |
Motivation
It's useful for clients to be able to have a centralized way to handle decoding errors, which can be useful for logging or telemetry.
See apple/swift-openapi-generator#522 for more discussion on this.
Modifications
Add a new
DecodingErrorHandlerprotocol which has a singlewillThrow(_ error: any Error)requirement.A decoding handler can be passed to the client configuration on initialization.
This is just a proof-of-concept, if this direction is reasonable, it should be fleshed out to handle all decoding paths.
Result
With this change, errors produced by body decoders can be intercepted in a centralized way for all methods going through the
Client.Test Plan
I added a simple unit test. More tests would need to be added to sufficiently cover the functionality being introduced here.